home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / tag_bbs / tag2bw2b.zip / TAG2BW.DOC < prev    next >
Text File  |  1992-12-02  |  21KB  |  544 lines

  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.                     T . A . G  T o  B l u e  W a v e  D o o r
  8.                        I n t e r f a c e  U t i l i t i e s
  9.                               V e r s i o n  2 . 0
  10.  
  11.  
  12. Acknowledgements
  13. ~~~~~~~~~~~~~~~
  14.                TAG is copyrighted by Victor Capton and Robert Numerick
  15.                    None of this interface package would be possible without
  16.                    the support the TAG team has give to third party utilities
  17.                    authors in terms of structures and functional programming
  18.                    aid. Special thanks go to Victor Capton, Paul Williams and
  19.                    Randy Goebel.. the current main force behind the TAG BBS
  20.                    systems.
  21.  
  22.                    Blue Wave is copyrighted by Cutting Edge Computing. The
  23.                    author is George Hatchew. Thanks go to George as well for
  24.                    providing insight into how the door interfaces with the
  25.                    QBBS V7.5 BBS system thus eliminating a couple of major
  26.                    brain busters.
  27.  
  28.                XTRA special thanks go to the people who did the beta testing
  29.                     for this utility package:
  30.  
  31.                     John Nash         1:374/10
  32.                     Jason Brothers    1:101/352
  33.                     David Beiger      1:374/5
  34.                     Jonathan Blair    1:2605/630
  35.                     Steven Sheeley    1:374/302
  36.                     Cliff Morrison    1:163/412
  37.                     Chris Howes       1:374/69
  38.                     Justin Gould      1:231/272
  39.                     Todd Punderson    1:321/309
  40.                     Vince Worthington 1:3629/405
  41.  
  42. Guarantees/Warranties
  43. ~~~~~~~~~~~~~~~~~~~~~
  44.  
  45. Simply Put, There are no guarantees that this software will do anything
  46. but take up disk space. The author assumes no liability for any damages
  47. caused by running the related programs.. This disclaimer includes, but
  48. is not limited to loss of data, or destruction of files.
  49.  
  50. Blue Wave Files Needed
  51. ~~~~~~~~~~~~~~~~~~~~~~
  52.  
  53.         BW101_QB.ZIP    QBBS V2.75 Blue Wave Mail Door
  54.         BWAVE211.ZIP    Latest Blue Wave Reader
  55.  
  56.         Both Files are FREQable from Here (1:236/16)
  57.  
  58.  
  59. Purpose
  60. ~~~~~~~
  61. This utility set is designed to ease the interface of the Blue Wave mail
  62. door and TAG BBS systems. The included programs create a QBBS V7.5
  63. system for use by the Blue Wave mail Door.. and any other QBBS V7.5 type
  64. door or utilities that need the resulting files.
  65.  
  66.  
  67. -=[ TAG2BW Documentation Page 1 ]=-               Main operation/use outline
  68.  
  69.  
  70. Use
  71. ~~~
  72.  
  73. The use of these utilities is two step:
  74.  
  75.         1. Unzip the file TAG2QBBS into the Blue Wave Directory and
  76.            execute. Upon execution you will be prompted for two
  77.            directories. The first is the path to your Status.Dat File..
  78.            the second the path to the HMS base you are setting up. Bear in
  79.            mind the STATUS.DAT path you enter will be based upon the node you
  80.            are setting up. (see the recommended Multi-node setup later in the
  81.            docs)
  82.  
  83.            -=[ NOTE ]=-
  84.                 To run as a nightly event and keep the message areas,
  85.                 files areas, and List files up to date enter the two
  86.                 paths on the command line as follows.
  87.                       TAG2QBBS C:\BBS C:\HMSPATH
  88.  
  89.                 It is recommended you perform this maintenance for each node
  90.                 every night or after adding or deleting message or file areas.
  91.                 This program also creates standard QBBS V2.75 FILES.BBS files
  92.                 in each of your download directories.. if the directory is a
  93.                 CDROM drive then the list file is generated in the same
  94.                 directory as the *.DIR file and is named based on the
  95.                 following convention:
  96.                               F[File Area Number].BBS
  97.  
  98.                 So if a CDROM area is area #321 and the .DIR file was located
  99.                 in the multi-node directory the list file name would be:
  100.                                   C:\MULTI\F321.BBS
  101.  
  102.                 These list files are essential to Blue Wave's ability to allow
  103.                 users to request files via the door and should not be
  104.                 disturbed.
  105.  
  106.  
  107.  
  108.            This program will create:
  109.  
  110.            QUICKCFG.DAT         QBBS system file similar to STATUS.DAT
  111.            MSGCFG  .DAT         Message Base Configuration/Definition
  112.            FILECFG .DAT         File Base Configuration/Definition
  113.            LIMITS  .CTL         Download/Upload Ratio and Time Control
  114.            FILES   .BBS         List File For User File Requests.
  115.            F[DIR#] .BBS         CDROM List File(s)
  116.  
  117.  
  118.            Now you can run the Blue Wave setup Program BWUTILS.EXE and
  119.            toggle the board specific options. (Multi Node Setup Is Later
  120.            In Documentation so read EVERYTHING before starting!)
  121.  
  122.  
  123.  
  124. -=[ TAG2BW Documentation Page 2 ]=-        Setting Up The Blue Wave Door....
  125.  
  126.  
  127.                 General Information:
  128.                         Set packet name, Max Messages to download, Max
  129.                         Files for FREQ, and the various display files.
  130.                         
  131.                 Overrides
  132.                         Any areas you wish to force or exclude. You can
  133.                         force exclusion from users even if they normally
  134.                         have access and can setup default areas which
  135.                         the users will use depending upon their normal
  136.                         access, or change the access requirements to be
  137.                         different than those on the BBS. You will only
  138.                         see the message area listing when you choose to
  139.                         insert a new area.. rest assured ALL of your HMS
  140.                         areas are known to Blue Wave.
  141.  
  142.                 Directories and paths
  143.                         Check these but they should all be correct
  144.                         except the local download, upload paths. The
  145.                         swap path should default to the path you have
  146.                         setup for TAG or none..
  147.  
  148.                         For multi-Node setups make sure your System
  149.                         Path points to the specific QBBS path for that
  150.                         Node Directory beneath Blue Wave.
  151.  
  152.  
  153.  
  154.                 Security level and flags
  155.                         This simply setups up default flags and flag
  156.                         override access for netmail. It defaults to the
  157.                         QBBS sysop security level of 32000 and you will
  158.                         need to make the appropriate changes. If you
  159.                         wish to toggle flag access just remember the TAG
  160.                         A/R flags are toggled as the first 27 flags so a
  161.                         use that had flags of @A--DEF would translate to
  162.                         XX--XXX in Blue Wave. (ALL Users have the @ flag)
  163.  
  164.  
  165.            That should do it for initial setup.. Oh yeah.. If you wish to
  166.            have a HMS netmail base within TAG just setup your desired
  167.            message base as a RA/QBBS type echo base and once completed
  168.            go back and change the base type to NetMail and it will
  169.            remain as a fully functional HMS netmail base. The One limitation
  170.            is TAG will allow you to set the various netmail attributes but
  171.            will only display the "Local" attribute. In my own experience
  172.            everything *should* toss correctly (at least it does under
  173.            D'Bridge's HMS tosser).
  174.  
  175.  
  176.  
  177. -=[ TAG2BW Documentation Page 3 ]=-     Interfacing TAG to the Blue Wave Door
  178.  
  179.  
  180.         2. Edit the included BW.BAT file and place it in your TAG BBS
  181.            directory then place the TAG2BW.EXE file in your Blue Wave
  182.            directory. Add a menu option of
  183.                 Pkey    <
  184.                 Pdata   BW(??).BAT
  185.  
  186.            (You will need a separate Menu and Batch file for each HMS
  187.            directory. The "??" referres to NODE/HMSBASE Numbers)
  188.  
  189.           The files created by TAG2BW.EXE are:
  190.  
  191.                 EXITINFO.BBS    User information file that can be
  192.                                 changed by door
  193.                 ALIAS   .BBS    Alias file for users
  194.                 USERS   .BBS    All user information (like USER.LST)
  195.                 DORINFO?.DEF    Door drop file
  196.  
  197.  
  198. That should be about all I need tell you at this time other than read
  199. the Blue Wave Docs and you should easily see how to use these programs
  200. for setting up Multiple Nodes and HMS bases.
  201.  
  202. You will also note that Blue Wave will respect your user's handles and
  203. will Force Handles to be used on any area you force handles and will not
  204. allow handles in any area you have handles disabled... There is no such
  205. thing as anonymous on QBBS boards so these areas have handles forced.
  206.  
  207. A Word about local File Requests:
  208. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  209.  
  210. As stated earlier, it is crucial that a correctly formatted FILES.BBS or
  211. alternate list file exists for the file request options to work. Any files
  212. that are downloaded will applied toward the user's File download count and
  213. Download-K statistics. If the user is out of balance Blue Wave will not allow
  214. the user to download. If you are using another program to create your BBS's
  215. FILES.BBS please remember that it probably won't be placing the alternate list
  216. files in the correct place for the CDROMs and may well inhibit the user
  217. downloading ability. If there is a specific area you do NOT wish users to
  218. access via Blue Wave, regardless of their BBS access rights simply include a
  219. command in your maintenance batch file to delete that file area's FILES.BBS or
  220. alternate list file (F(are#).BBS).. then Blue Wave will treat the file as non
  221. existent even though it finds it in the appropriate directory.
  222.  
  223. As with TAG, Blue Wave will not charge Users for downloading from file
  224. areas marked as Free <no ratios>.
  225.  
  226.  
  227.  
  228. -=[ TAG2BW Documentation Page 4 ]=-                            Mulitnode Setup
  229.  
  230. For sake of example we will demonstrate the multi-node setup using a Two node
  231. system with the following directory structure for the BBS:
  232.  
  233. Node 1:
  234.      BBS dir  = C:\BBS
  235.      Gfiles   = C:\BBS\GFILES
  236.      AFiles   = C:\BBS\AFILES
  237.      MSG Dir  = C:\MESSAGES
  238.  
  239. Node 2:
  240.      BBS DIr  = C:\BBS2
  241.      Gfiles   = C:\BBS2\GFILES
  242.      AFiles   = C:\BBS2\AFILES
  243.      MSG DIR  = C:\MESSAGES
  244.  
  245. Multinode
  246.      MULTI Dir = C:\MULTI
  247.            USERS   .LST
  248.            CDROM   .DIR FILES
  249.            MBOARDS .DAT
  250.            FBOARDS .DAT
  251. Main Blue Wave Directory = C:\BW
  252.  
  253. In the above example the directory tree would look like:
  254.  
  255. ROOT--+
  256.       |
  257.       +----+ BBS   <-------- NODE1 STATUS.DAT Directory
  258.       |        |
  259.       |        + AFILES
  260.       |        |
  261.       |        + GFILES
  262.       |
  263.       +----+ BBS2  <------- NODE2 STATUS.DAT Directory
  264.       |        |
  265.       |        + AFILES
  266.       |        |
  267.       |        + GFILES
  268.       |
  269.       +----+ BW    <------- Main Blue Wave Directory (includes all *.PRM
  270.       |       |                                       Files)
  271.       |       + NODE1  <----- NODE1 QBBS System Directory. Must Contain
  272.       |       |    |                TAG2QBBS.EXE
  273.       |       |    + DOWN
  274.       |       |    |
  275.       |       |    + UP
  276.       |       |    |
  277.       |       |    + WORK
  278.       |       |
  279.       |       + NODE2  <----- NODE2 QBBS System Directory. Must Contain
  280.       |            |                TAG2QBBS.EXE
  281.       |            + DOWN
  282.       |            |
  283.       |            + UP
  284.       |            |
  285.       |            + WORK
  286.       |
  287.       +----+ MESSAGES  <----- HMS Files (Single HMS Base System)
  288.       |
  289.       +----+ MULTI
  290.  
  291.  
  292.  
  293. -=[ TAG2BW Documentation Page 5 ]=-                         Mulitnode Setup
  294.  
  295. Given the preceding directory structure the calling conventions for each
  296. program would be:
  297.  
  298.         BWUTILS.EXE -  Called from main Blue Wave directory
  299.         ~~~~~~~~~~~
  300.                    NODE1
  301.                         BWUTILS NODE1.PRM
  302.  
  303.                    NODE2
  304.                         BWUTILS NODE2.PRM
  305.  
  306.         TAG2QBBS    - Called from Each C:\BW\NODE? Directory
  307.         ~~~~~~~~
  308.                    NODE1
  309.                         TAG2QBBS C:\BBS C:\MESSAGES
  310.  
  311.                    NODE2
  312.                         TAG2QBBS C:\BBS2 C:\MESSAGES
  313.  
  314.         TAG2BW      - Called from main Blue Wave Directory
  315.         ~~~~~~
  316.                    NODE1
  317.                         TAG2BW %1 %2 %3 %4 %5 %6 %7 C:\BW\NODE1 C:\BBS
  318.  
  319.                    NODE2
  320.                         TAG2BW %1 %2 %3 %4 %5 %6 %7 C:\BW\NODE2 C:\BBS2
  321.  
  322.          BWMAIL     - Called from main Blue Wave Directory
  323.  
  324.                    NODE1
  325.                         BWMAIL -CNODE1.PRM
  326.  
  327.                    NODE2
  328.                         BWMAIL -CNODE2.PRM
  329.  
  330.          TAGUDATE   - Called From Main Blue Wave Directory
  331.          ~~~~~~~~
  332.                    NODE1
  333.                         TAGUDATE C:\BW\NODE1 C:\BBS
  334.  
  335.                    NODE2
  336.                         TAGUDATE C:\BW\NODE2 C:\BBS2
  337.  
  338. =============================[ Batch Files ]================================
  339.  
  340. NODE1
  341. ~~~~~
  342.      @Echo Off
  343.      C:
  344.      Cd\BW
  345.      TAG2BW %1 %2 %3 %4 %5 %6 %7 C:\BW\NODE1 C:\BBS
  346.      BWMAIL -CNODE1.PRM
  347.      TAGUDATE C:\BW\NODE1 C:\BBS
  348.      CD\BBS
  349.  
  350.  
  351.  
  352. -=[ TAG2BW Documentation Page 6 ]=-                         Multinode Setup
  353.  
  354. NODE2
  355. ~~~~~
  356.      @Echo Off
  357.      C:
  358.      Cd\BW
  359.      TAG2BW %1 %2 %3 %4 %5 %6 %7 C:\BW\NODE2 C:\BBS2
  360.      :
  361.      : The Next Line is due to Blue Wave's lack of recognizing
  362.      : any DORINFO?.DEF file except DORINFO1.DEF
  363.      :
  364.      COPY C:\BW\NODE2\DORINFO2.DEF C:\BW\NODE2\DORINFO1.DEF
  365.      BWMAIL -CNODE2.PRM
  366.      TAGUDATE C:\BW\NODE2 C:\BBS2
  367.      CD\BBS2
  368.  
  369. As noted in the Batch file comments (any line preceded by a colon and not
  370. referred to as a Label is ignored by dos and serves as a comment) Blue Wave
  371. doesn't recognize node specific DORINFO?.DEF files.. I elected to create them
  372. anyway and allow the sysop to make the appropriate copy so the utility can
  373. serve to create the files for other QBBS V7.5 Doors and utilities that do
  374. recognize the node specific DORINFO? naming convention.
  375.  
  376. Now for the multiple HMS systems. First off there is absolutely NO good reason
  377. for creating multiple HMS areas under TAG unless you have in excess of 200
  378. messages areas (Lord) or your message base size has exceeded 16mg (Double oh
  379. lord).. This only serves to break other fine utilities, editors, etc, that would
  380. otherwise handle the message system flawlessly. As for data integrity, well
  381. you can always go back to the FIDO *.MSG message format. Really, the HMS
  382. system is pretty stable and shouldn't give you problems and if you end up with
  383. bad sectors you are likely to have other problems anyway.
  384.  
  385. To use the multiple HMS message bases the same rules apply as in the
  386. preceding example with the addition of a new QBBS system Dir for each extra
  387. HMS base... and of course a corresponding Blue Wave .PRM file. The additional
  388. directories would appear as :
  389.  
  390. BW
  391.  +
  392.  |
  393.  + NODE1     <---- TAG2QBBS resides here with node1 HMS1 paths
  394.  |    +
  395.  |    |
  396.  |    + HMS2 <---- TAG2QBBS resides here with NODE1 HMS2 paths
  397.  |    |
  398.  |    + HMS3 <---- TAG2QBBS resides here with NODE1 HMS3 Paths
  399.  |    |
  400.  |    + DOWN
  401.  |    |
  402.  |    + WORK
  403.  |    |
  404.  |    + UP
  405.  |
  406.  + NODE2     <---- TAG2QBBS resides here with NODE2 HMS 1 paths. The rest is
  407.  |    +                     is the same as above.
  408.  
  409. Naturally there would then be  NODE11.PRM, NODE12.PRM, NODE13.PRM files for
  410. Blue Wave and TAG2QBBS would have to be called from each directory with the
  411. paths pointing to the appropriate BBS node dir and HMS message base. heh..
  412. this is what you get for prostituting a *standard*.
  413.  
  414.  
  415.  
  416. -=[ TAG2BW Documentation Page 7 ]=-                               Postscript
  417.  
  418.  
  419. If there are any questions or comments direct them to:
  420.  
  421. Rick Cooper
  422. Just For the Heck Of It II
  423. 1:236/16
  424. (219) 747-5871
  425.  
  426.  
  427. - 11/13/92
  428.  
  429. Modified the File Sharing Scheme slightly, and added a couple more error
  430. messages for missing files.
  431.  
  432. -11/14/92
  433.  
  434. -=[FIXED]=-
  435.  
  436. Problem with Runtime error 201 Fixed! A bit of sloppy programming..
  437. Heh.. Probably not the last time. (Thanks Both John and Jason)
  438.  
  439. Fixed Sysop handle problem.. Seems QBBS doesn't use the first record
  440. number for the Alias.bbs file thus all user handles functioned except
  441. good 'ole Sysop User #1
  442.  
  443.  
  444. Modified the way files are located.. Function will now search the Dos
  445. path as well as the TAG file definitions.
  446.  
  447. Added creation of an error file TAG2BW.ERR in the Main BBS directory.
  448. This file does slow down the program a bit but should help me find
  449. exactly where in the program an error is occurring .. it also contains
  450. several of the system variables needed by the program and looks like :
  451.  
  452.         System Path    = C:\BBS\
  453.         Blue Wave Path = C:\BW\
  454.         Share Installed
  455.         DesqView Not Active
  456.         Found C:\BBS\GFILES\Callers.Log
  457.         Converting User Information For ExitInfo.BBS
  458.         ExitInfo.BBS Definition Is Complete
  459.         Writing ExitInfo 1..C:\BW\EXITINFO.BBS
  460.         Writing ExitInfo 2..C:\BBS\MESSAGES\HUDSON\EXITINFO.BBS
  461.         Writing Alias.Bbs File...  C:\BBS\MESSAGES\HUDSON\ALIAS.BBS
  462.         Writing Combine.Bbs File.. C:\BBS\MESSAGES\HUDSON\Combined.BBS
  463.         Reading USER.LST File C:\BBS\MULTI\USER.LST
  464.         Assigning USERS.BBS File.. C:\BBS\MESSAGES\HUDSON\USERS.BBS
  465.         Reading Scan Flag File C:\BBS\MULTI\MZSCAN.DAT
  466.         Creating USERS.BBS File.. Reading USER.LST
  467.         Finished Writing C:\BBS\MESSAGES\HUDSON\USERS.BBS
  468.         Writing C:\BW\DORINFO1.DEF
  469.         All Files Written and Read.. Conversion Complete
  470.  
  471. -11/18/92
  472.  
  473. Added communications routines so the user sees the Information Displayed
  474. locally.. Also added a "Percent Done" line so the user knows something
  475. is happening while the program writes the USERS.BBS file.
  476. This adds a couple seconds to the creation routines but the user will
  477. probably appreciate knowing that something is happening while they
  478. wait... Let me know
  479.  
  480.  
  481. -=[ TAG2BW Documentation Page 8 ]=-                               Postscript
  482.  
  483.  
  484. -11/20/92
  485.  
  486. Changed the status display so it only updates every 10% done which speeds
  487. things back up considerably.
  488.  
  489. -11/21/92
  490.  
  491. Increased the stack space.. there were a couple of reports of lockups
  492. running under DesqView386 standard (not DV/X) and the problem has been
  493. traced to the STACKS=0,0 statement in the CONFIG.SYS. Hopefully V1h will
  494. correct these lockups.
  495.  
  496. -11/21/92
  497.  
  498. Further increased the Stack space available (some real dead iron out
  499. there apparently) and fixed the problem with not locating File requested
  500. for download. Users will now be able to FREQ any files they normally
  501. have access to (and ratios/limits are enforced as is security access),
  502. except in a CDROM directory.
  503.  
  504. If the current version still locks up under DV386 V2.4? rem out your
  505. Stacks= statement in the config.sys file and try again.. that will
  506. *probably* handle it now.
  507.  
  508. -11/25/92
  509.  
  510. Added the ability to create the proper style FILES.BBS to the TAG2QBBS
  511. program. Also allows TAG2QBBS to accept command line parameters so it
  512. can be run as a nightly event thus keeping your files and message setups
  513. current as well as any List Files for Blue Wave.
  514.  
  515.         Parameters are:
  516.         TAG2QBBS C:\BBS C:\HMS
  517.  
  518.         Where C:\BBS = Path To Status.Dat and C:\HMS = Message Base Path
  519.  
  520. If you are keeping your .DIR files the Gfiles, Afiles, Or Multi
  521. directories, a file will be created within that directory with the
  522. naming convention of F+BoardNumber.BBS (eg: F1.BBS).. Please Don't
  523. remove those files or Blue Wave will Not be able to find the file your
  524. user is attempting to request.
  525.  
  526. Removed all the error log code.. it would appear it's not needed.. well, I
  527. didn't actually remove it I just commented it out so it can be restored if
  528. needed.
  529.  
  530. -11/28/92
  531.  
  532. Added the utility TAGUDATE.EXE. This program reads the EXITINFO.BBS file
  533. and updates the user's File Download-K and count, Post Count, and
  534. Netmail credit/debits. All the user post counts have to go into their
  535. public post count regardless of the type (private/public/echo, etc)
  536. because QBBS doesn't differentiate between types when it comes to
  537. counts.
  538.  
  539. -12/01/92
  540.  
  541. Public release of the Door and rewriting of the bloody doc files.. I hate
  542. writing docs ..
  543.  
  544.